package cn.sytton.taffecloud.common.base.doc;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 在线接口文档参数注解
 *
 * @author skyrock
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiImplicitParam {

    /**
     * 参数名
     */
    String name() default "";

    /**
     * 参数的具体意义
     */
    String value() default "";

    /**
     * 备注
     */
    String notes() default "";

    /**
     * 参数的数据类型
     */
    Class<?> dataTypeClass() default String.class;

    /**
     * 查询参数类型
     */
    ParamType paramType();

    /**
     * 参数是否必填
     */
    boolean required() default true;

}
